Skip to content

Conversation

qmonmert
Copy link
Contributor

URLs in readme.md are KO

Examples:

URLs with releases have date now (ex: https://www.jhipster.tech/2025/05/06/jhipster-release-8.11.0.html)

My proposition is:
Before

This application was generated using JHipster 8.11.0, you can find documentation and help at [https://www.jhipster.tech/documentation-archive/v8.11.0](https://www.jhipster.tech/documentation-archive/v8.11.0).

After

This application was generated using JHipster 8.11.0, you can find documentation and help at [https://www.jhipster.tech/releases/](https://www.jhipster.tech/releases/).

Before

[JHipster 8.11.0 archive]: https://www.jhipster.tech/documentation-archive/v8.11.0
[Using JHipster in development]: https://www.jhipster.tech/documentation-archive/v8.11.0/development/
[Using Docker and Docker-Compose]: https://www.jhipster.tech/documentation-archive/v8.11.0/docker-compose
[Using JHipster in production]: https://www.jhipster.tech/documentation-archive/v8.11.0/production/
[Running tests page]: https://www.jhipster.tech/documentation-archive/v8.11.0/running-tests/
[Code quality page]: https://www.jhipster.tech/documentation-archive/v8.11.0/code-quality/
[Setting up Continuous Integration]: https://www.jhipster.tech/documentation-archive/v8.11.0/setting-up-ci/

After

[JHipster releases]: https://www.jhipster.tech/releases/
[Using JHipster in development]: https://www.jhipster.tech/development/
[Using Docker and Docker-Compose]: https://www.jhipster.tech/docker-compose
[Using JHipster in production]: https://www.jhipster.tech/production/
[Running tests page]: https://www.jhipster.tech/running-tests/
[Code quality page]: https://www.jhipster.tech/code-quality/
[Setting up Continuous Integration]: https://www.jhipster.tech/setting-up-ci/
image image

@DanielFran @mshima WDYT?

@qmonmert qmonmert marked this pull request as ready for review September 11, 2025 20:09
@mshima
Copy link
Member

mshima commented Sep 12, 2025

@SvMak suggestions?

@SvMak
Copy link

SvMak commented Sep 12, 2025

@SvMak suggestions?

@mshima

As far as I understand, the point of archive links is that the documentation changes, and they are used to maintain the connection between the documentation version and the generator. And this update will break this connection. The generator of any new version will link to the current version of the documentation even if something in it is out of date.

P.S. I saw that the archive was broken, I'll look at it a little later.

@DanielFran
Copy link
Member

@qmonmert Seems that we can close it, right?

@qmonmert
Copy link
Contributor Author

@DanielFran not fixed I think @SvMak ?

@SvMak
Copy link

SvMak commented Oct 10, 2025

@qmonmert

If I understand correctly, then:

For example, if I'm using JHipster version 8.9.0 and creating a new project, my links point to the documentation, which corresponds to the generator version and is located in the archive.

But if create links that point to the latest version of the documentation (for example, 8.11.0), then I potentially end up with out-of-date documentation if changes have been made.

If this isn't critical, then this update is OK.

@qmonmert
Copy link
Contributor Author

@SvMak in the README of generated app with have some URLs like https://www.jhipster.tech/documentation-archive/v8.11.0
When you go on this URL, you have:
image
because the good URL now is: https://www.jhipster.tech/2025/05/06/jhipster-release-8.11.0.html
Dates are on the URL

@SvMak
Copy link

SvMak commented Oct 10, 2025

@qmonmert

The release link is a good idea.

As for the other links, it would be nice to clarify whether this would create the problem I described above.

@qmonmert
Copy link
Contributor Author

@SvMak I think the choice of the versions is not a big pb

@SvMak
Copy link

SvMak commented Oct 10, 2025

Alternatively, you could check: if using the latest version of the generator, then insert the links you suggest, otherwise, leave the current version with links to the archive. What do you think?

@qmonmert
Copy link
Contributor Author

For me, I think my proposition is simpler and clearer 😇

@SvMak
Copy link

SvMak commented Oct 10, 2025

For me, I think my proposition is simpler and clearer 😇

I like it!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants